Skip to content

Fix sphinx/jupyter heading issue in UDF notebook - #10690

Merged
rapids-bot[bot] merged 1 commit into
NVIDIA:branch-22.06from
brandon-b-miller:doc-udf-notebook-headings
Apr 20, 2022
Merged

rapids-bot[bot] merged 1 commit into
NVIDIA:branch-22.06from
brandon-b-miller:doc-udf-notebook-headings

Conversation

@brandon-b-miller

Copy link
Copy Markdown
Contributor

Fixes an issue where sphinx was reading the #'s in the UDF guide markdown cells as section headings causing strange effects in the docs main index page.

@brandon-b-miller brandon-b-miller added 3 - Ready for Review Ready for review by team doc Documentation Python Affects Python cuDF API. non-breaking Non-breaking change labels Apr 20, 2022
@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions Bot removed the Python Affects Python cuDF API. label Apr 20, 2022
@shwina

shwina commented Apr 20, 2022

Copy link
Copy Markdown
Contributor

@gpucibot merge

Comment on lines +7 to +8
"Overview of User Defined Functions with cuDF\n",
"===================================="

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the heading and the line below need to be of equal length, or else Sphinx throws warnings. Can you fix these and/or verify that no warnings are thrown?

Suggested change
"Overview of User Defined Functions with cuDF\n",
"===================================="
"Overview of User Defined Functions with cuDF\n",
"============================================"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I might be a little late commenting after Ashwin directed this PR to merge.)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of this is going to be fixed in #10685 anyway.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not getting warnings locally. I think it's because matching the character lengths is just a minimum, but I'm checking to make sure.

@codecov

codecov Bot commented Apr 20, 2022

Copy link
Copy Markdown

Codecov Report

Merging #10690 (9bbf119) into branch-22.06 (65b1cbd) will increase coverage by 0.03%.
The diff coverage is n/a.

@@               Coverage Diff                @@
##           branch-22.06   #10690      +/-   ##
================================================
+ Coverage         86.35%   86.38%   +0.03%     
================================================
  Files               142      142              
  Lines             22335    22335              
================================================
+ Hits              19287    19294       +7     
+ Misses             3048     3041       -7     
Impacted Files Coverage Δ
python/cudf/cudf/core/column/string.py 89.22% <0.00%> (+0.12%) ⬆️
python/cudf/cudf/core/groupby/groupby.py 91.64% <0.00%> (+0.23%) ⬆️
python/cudf/cudf/core/column/numerical.py 96.17% <0.00%> (+0.29%) ⬆️
python/cudf/cudf/core/tools/datetimes.py 84.49% <0.00%> (+0.30%) ⬆️
python/cudf/cudf/core/column/lists.py 92.79% <0.00%> (+1.27%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 65b1cbd...9bbf119. Read the comment docs.

@rapids-bot
rapids-bot Bot merged commit 5f6b70a into NVIDIA:branch-22.06 Apr 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3 - Ready for Review Ready for review by team doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants